<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <title>Xinc Guide - Core Tasks</title>
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
    <link rel="Stylesheet" rev="Stylesheet" href="../../css/Documentation.css" type="text/css" media="All" charset="iso-8859-1" />
</head>
<body>
<h1><a name="AppendixC"></a>Appendix C: Triggers</h1>

<p>
This appendix contains a reference of all trigger tasks, i.e. all tasks that are needed to start a build.
</p>
<h2><a name="ScheduleTask"></a>&lt;schedule/&gt;</h2>
<p> The Schedule Task sets the interval in which repository changes are looked up by the &lt;<a href="#ModificationSetTask">modificationset</a>/&gt;.</p>
<pre title="Example of how to use ScheduleTask">
&lt;<a href="AppendixB-CoreTasks.html#Project">project</a> name=&quot;ProjectName&quot;&gt;
    &lt;<a href="AppendixB-CoreTasks.html#TriggerTask">trigger</a>&gt;
        &lt;schedule interval=&quot;300&quot;/&gt;
    &lt;/trigger&gt;
...
&lt;/project&gt;
</pre>
<h3>Parent Tags</h3>
<ul>
  <li>&lt;<a href="AppendixB-CoreTasks.html#TriggerTask">trigger</a>/&gt;</li>
</ul>
<h3>Parameters</h3>
<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
      <th>Default</th>
      <th>Required</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>interval</td>
      <td>Integer</td>
      <td>Number of seconds in which modifications should be detected</td>
      <td>n/a</td>
      <td>Yes</td>
    </tr>
  </tbody>
</table>
<p>&nbsp;</p>
<h2><a name="CronTask"></a>&lt;cron/&gt;</h2>
<p> The Cron Task lets you specifiy a timer for monitoring repository by the &lt;<a href="#ModificationSetTask">modificationset</a>/&gt;.</p>
<pre title="Example of how to use CronTask">
&lt;<a href="AppendixB-CoreTasks.html#Project">project</a> name=&quot;ProjectName&quot;&gt;
    &lt;<a href="AppendixB-CoreTasks.html#TriggerTask">trigger</a>&gt;
        &lt;cron timer=&quot;*/5 * * * *&quot;/&gt;
    &lt;/trigger&gt;
...
&lt;/project&gt;
</pre>
<h3>Parent Tags</h3>
<ul>
  <li>&lt;<a href="AppendixB-CoreTasks.html#TriggerTask">trigger</a>/&gt;</li>
</ul>
<h3>Parameters</h3>
<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
      <th>Default</th>
      <th>Required</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>timer</td>
      <td>String</td>
      <td>Cron like configuration of timer</td>
      <td>n/a</td>
      <td>Yes</td>
    </tr>
  </tbody>
</table>
<h2><a name="SensorTask"></a>&lt;sensor/&gt;</h2>
<p> The Sensor Task lets you specifiy a file for monitoring to start a build. If file exists the build will start and the file will be removed.</p>
<pre title="Example of how to use CronTask">
&lt;<a href="AppendixB-CoreTasks.html#Project">project</a> name=&quot;ProjectName&quot;&gt;
    &lt;<a href="AppendixB-CoreTasks.html#TriggerTask">trigger</a>&gt;
        &lt;sensor file=&quot;path/to/file&quot;/&gt;
    &lt;/trigger&gt;
...
&lt;/project&gt;
</pre>
<h3>Parent Tags</h3>
<ul>
  <li>&lt;<a href="AppendixB-CoreTasks.html#TriggerTask">trigger</a>/&gt;</li>
</ul>
<h3>Parameters</h3>
<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
      <th>Default</th>
      <th>Required</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>file</td>
      <td>String</td>
      <td>Path to a file.</td>
      <td>n/a</td>
      <td>Yes</td>
    </tr>
  </tbody>
</table>
</body>
</html>
